Outreach REST API Reference

Download OpenAPI specification:Download

Account

A descriptor of a named company used to categorize prospects within an account-based sales approach.

buyerIntentScore
number <float>

A custom score given to measure the quality of the account.

companyType
string <= 255 characters

A description of the company’s type (e.g. "Public Company").

createdAt
string <date-time>

The date and time the account was created.

custom1
string <= 32000 characters

The value of the account’s first custom field.

custom2
string <= 32000 characters

The value of the account’s second custom field.

custom3
string <= 32000 characters

The value of the account’s third custom field.

custom4
string <= 32000 characters

The value of the account’s fourth custom field.

custom5
string <= 32000 characters

The value of the account’s fifth custom field.

custom6
string <= 32000 characters

The value of the account’s sixth custom field.

custom7
string <= 32000 characters

The value of the account’s seventh custom field.

custom8
string <= 32000 characters

The value of the account’s eight custom field.

custom9
string <= 32000 characters

The value of the account’s ninth custom field.

custom10
string <= 32000 characters

The value of the account’s 10th custom field.

custom11
string <= 32000 characters

The value of the account’s 11th custom field.

custom12
string <= 32000 characters

The value of the account’s 12th custom field.

custom13
string <= 32000 characters

The value of the account’s 13th custom field.

custom14
string <= 32000 characters

The value of the account’s 14th custom field.

custom15
string <= 32000 characters

The value of the account’s 15th custom field.

custom16
string <= 32000 characters

The value of the account’s 16th custom field.

custom17
string <= 32000 characters

The value of the account’s 17th custom field.

custom18
string <= 32000 characters

The value of the account’s 18th custom field.

custom19
string <= 32000 characters

The value of the account’s 19th custom field.

custom20
string <= 32000 characters

The value of the account’s 20th custom field.

custom21
string <= 32000 characters

The value of the account’s 21st custom field.

custom22
string <= 32000 characters

The value of the account’s 22nd custom field.

custom23
string <= 32000 characters

The value of the account’s 23rd custom field.

custom24
string <= 32000 characters

The value of the account’s 24th custom field.

custom25
string <= 32000 characters

The value of the account’s 25th custom field.

custom26
string <= 32000 characters

The value of the account’s 26th custom field.

custom27
string <= 32000 characters

The value of the account’s 27th custom field.

custom28
string <= 32000 characters

The value of the account’s 28th custom field.

custom29
string <= 32000 characters

The value of the account’s 29th custom field.

custom30
string <= 32000 characters

The value of the account’s 30th custom field.

custom31
string <= 32000 characters

The value of the account’s 31st custom field.

custom32
string <= 32000 characters

The value of the account’s 32nd custom field.

custom33
string <= 32000 characters

The value of the account’s 33rd custom field.

custom34
string <= 32000 characters

The value of the account’s 34th custom field.

custom35
string <= 32000 characters

The value of the account’s 35th custom field.

custom36
string <= 32000 characters

The value of the account's 36th custom field.

custom37
string <= 32000 characters

The value of the account's 37th custom field.

custom38
string <= 32000 characters

The value of the account's 38th custom field.

custom39
string <= 32000 characters

The value of the account's 39th custom field.

custom40
string <= 32000 characters

The value of the account's 40th custom field.

custom41
string <= 32000 characters

The value of the account's 41st custom field.

custom42
string <= 32000 characters

The value of the account's 42nd custom field.

custom43
string <= 32000 characters

The value of the account's 43rd custom field.

custom44
string <= 32000 characters

The value of the account's 44th custom field.

custom45
string <= 32000 characters

The value of the account's 45th custom field.

custom46
string <= 32000 characters

The value of the account's 46th custom field.

custom47
string <= 32000 characters

The value of the account's 47th custom field.

custom48
string <= 32000 characters

The value of the account's 48th custom field.

custom49
string <= 32000 characters

The value of the account's 49th custom field.

custom50
string <= 32000 characters

The value of the account's 50th custom field.

custom51
string <= 32000 characters

The value of the account's 51st custom field.

custom52
string <= 32000 characters

The value of the account's 52nd custom field.

custom53
string <= 32000 characters

The value of the account's 53rd custom field.

custom54
string <= 32000 characters

The value of the account's 54th custom field.

custom55
string <= 32000 characters

The value of the account's 55th custom field.

custom56
string <= 32000 characters

The value of the account's 56th custom field.

custom57
string <= 32000 characters

The value of the account's 57th custom field.

custom58
string <= 32000 characters

The value of the account's 58th custom field.

custom59
string <= 32000 characters

The value of the account's 59th custom field.

custom60
string <= 32000 characters

The value of the account's 60th custom field.

custom61
string <= 32000 characters

The value of the account's 61st custom field.

custom62
string <= 32000 characters

The value of the account's 62nd custom field.

custom63
string <= 32000 characters

The value of the account's 63rd custom field.

custom64
string <= 32000 characters

The value of the account's 64th custom field.

custom65
string <= 32000 characters

The value of the account's 65th custom field.

custom66
string <= 32000 characters

The value of the account's 66th custom field.

custom67
string <= 32000 characters

The value of the account's 67th custom field.

custom68
string <= 32000 characters

The value of the account's 68th custom field.

custom69
string <= 32000 characters

The value of the account's 69th custom field.

custom70
string <= 32000 characters

The value of the account's 70th custom field.

custom71
string <= 32000 characters

The value of the account's 71st custom field.

custom72
string <= 32000 characters

The value of the account's 72nd custom field.

custom73
string <= 32000 characters

The value of the account's 73rd custom field.

custom74
string <= 32000 characters

The value of the account's 74th custom field.

custom75
string <= 32000 characters

The value of the account's 75th custom field.

custom76
string <= 32000 characters

The value of the account's 76th custom field.

custom77
string <= 32000 characters

The value of the account's 77th custom field.

custom78
string <= 32000 characters

The value of the account's 78th custom field.

custom79
string <= 32000 characters

The value of the account's 79th custom field.

custom80
string <= 32000 characters

The value of the account's 80th custom field.

custom81
string <= 32000 characters

The value of the account's 81st custom field.

custom82
string <= 32000 characters

The value of the account's 82nd custom field.

custom83
string <= 32000 characters

The value of the account's 83rd custom field.

custom84
string <= 32000 characters

The value of the account's 84th custom field.

custom85
string <= 32000 characters

The value of the account's 85th custom field.

custom86
string <= 32000 characters

The value of the account's 86th custom field.

custom87
string <= 32000 characters

The value of the account's 87th custom field.

custom88
string <= 32000 characters

The value of the account's 88th custom field.

custom89
string <= 32000 characters

The value of the account's 89th custom field.

custom90
string <= 32000 characters

The value of the account's 90th custom field.

custom91
string <= 32000 characters

The value of the account's 91st custom field.

custom92
string <= 32000 characters

The value of the account's 92nd custom field.

custom93
string <= 32000 characters

The value of the account's 93rd custom field.

custom94
string <= 32000 characters

The value of the account's 94th custom field.

custom95
string <= 32000 characters

The value of the account's 95th custom field.

custom96
string <= 32000 characters

The value of the account's 96th custom field.

custom97
string <= 32000 characters

The value of the account's 97th custom field.

custom98
string <= 32000 characters

The value of the account's 98th custom field.

custom99
string <= 32000 characters

The value of the account's 99th custom field.

custom100
string <= 32000 characters

The value of the account’s 100th custom field.

custom101
string <= 32000 characters

The value of the account’s 101st custom field.

custom102
string <= 32000 characters

The value of the account’s 102nd custom field.

custom103
string <= 32000 characters

The value of the account’s 103rd custom field.

custom104
string <= 32000 characters

The value of the account’s 104th custom field.

custom105
string <= 32000 characters

The value of the account’s 105th custom field.

custom106
string <= 32000 characters

The value of the account’s 106th custom field.

custom107
string <= 32000 characters

The value of the account’s 107th custom field.

custom108
string <= 32000 characters

The value of the account’s 108th custom field.

custom109
string <= 32000 characters

The value of the account’s 109th custom field.

custom110
string <= 32000 characters

The value of the account’s 110th custom field.

custom111
string <= 32000 characters

The value of the account’s 111th custom field.

custom112
string <= 32000 characters

The value of the account’s 112th custom field.

custom113
string <= 32000 characters

The value of the account’s 113th custom field.

custom114
string <= 32000 characters

The value of the account’s 114th custom field.

custom115
string <= 32000 characters

The value of the account’s 115th custom field.

custom116
string <= 32000 characters

The value of the account’s 116th custom field.

custom117
string <= 32000 characters

The value of the account’s 117th custom field.

custom118
string <= 32000 characters

The value of the account’s 118th custom field.

custom119
string <= 32000 characters

The value of the account’s 119th custom field.

custom120
string <= 32000 characters

The value of the account’s 120th custom field.

custom121
string <= 32000 characters

The value of the account’s 121st custom field.

custom122
string <= 32000 characters

The value of the account’s 122nd custom field.

custom123
string <= 32000 characters

The value of the account’s 123rd custom field.

custom124
string <= 32000 characters

The value of the account’s 124th custom field.

custom125
string <= 32000 characters

The value of the account’s 125th custom field.

custom126
string <= 32000 characters

The value of the account’s 126th custom field.

custom127
string <= 32000 characters

The value of the account’s 127th custom field.

custom128
string <= 32000 characters

The value of the account’s 128th custom field.

custom129
string <= 32000 characters

The value of the account’s 129th custom field.

custom130
string <= 32000 characters

The value of the account’s 130th custom field.

custom131
string <= 32000 characters

The value of the account’s 131st custom field.

custom132
string <= 32000 characters

The value of the account’s 132nd custom field.

custom133
string <= 32000 characters

The value of the account’s 133rd custom field.

custom134
string <= 32000 characters

The value of the account’s 134th custom field.

custom135
string <= 32000 characters

The value of the account’s 135th custom field.

custom136
string <= 32000 characters

The value of the account’s 136th custom field.

custom137
string <= 32000 characters

The value of the account’s 137th custom field.

custom138
string <= 32000 characters

The value of the account’s 138th custom field.

custom139
string <= 32000 characters

The value of the account’s 139th custom field.

custom140
string <= 32000 characters

The value of the account’s 140th custom field.

custom141
string <= 32000 characters

The value of the account’s 141st custom field.

custom142
string <= 32000 characters

The value of the account’s 142nd custom field.

custom143
string <= 32000 characters

The value of the account’s 143rd custom field.

custom144
string <= 32000 characters

The value of the account’s 144th custom field.

custom145
string <= 32000 characters

The value of the account’s 145th custom field.

custom146
string <= 32000 characters

The value of the account’s 146th custom field.

custom147
string <= 32000 characters

The value of the account’s 147th custom field.

custom148
string <= 32000 characters

The value of the account’s 148th custom field.

custom149
string <= 32000 characters

The value of the account’s 149th custom field.

custom150
string <= 32000 characters

The value of the account’s 150th custom field.

customId
string <= 255 characters

A custom ID for the account, often referencing an ID in an external system.

description
string <= 65535 characters

A custom description of the account.

domain
string <= 255 characters

The company’s website domain (e.g. "www.acme.com").

externalSource
string <= 255 characters

The source of the resource’s creation (e.g. "outreach-api").

followers
integer

The number of followers the company has listed on social media.

foundedAt
string <date-time>

The founding date of the company.

industry
string <= 255 characters

A description of the company’s industry (e.g. "Manufacturing").

linkedInEmployees
integer

The number of employees listed on the company’s LinkedIn URL.

linkedInUrl
string <= 1000 characters

The company’s LinkedIn URL.

locality
string <= 255 characters

The company’s primary geographic region (e.g. "Eastern USA").

name
string <= 255 characters

The name of the company (e.g. "Acme Corporation").

named
boolean

A boolean value determining whether this is a "named" account or not. Only named accounts will show up on the collection index.

naturalName
string <= 255 characters

The natural name of the company (e.g. "Acme").

numberOfEmployees
integer

The number of employees working at the company.

sharingTeamId
string <= 255 characters

The ID of the sharing team associated with this object. Access is currently in beta.

tags
Array of strings

A list of tag values associated with the account (e.g. ["Enterprise", "Tier 1"]).

touchedAt
string <date-time>

The date and time the account was last touched.

updatedAt
string <date-time>

The date and time the account was last updated.

websiteUrl
string <= 255 characters

The company’s website URL (e.g. "https://www.acme.com/contact").

{
}

Account Relationships

(user (data (object) or links (object)))

The creator of the account. Relationship creator cannot be used as a filter.

data (object) or links (object) (user)

The owner of the account. You can use only the attribute id to filter accounts by owner (e.g. filter[owner][id]=X).

Array of links (object) (prospect)

The account's associated prospects. Relationship prospects cannot be used as a filter.

Array of links (object) (task)

The associated tasks. Relationship tasks cannot be used as a filter.

(user (data (object) or links (object)))

The most recent updater of the account. Relationship updater cannot be used as a filter.

{
}

Account Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given Account has to external sources. provideDataConnections

⌵ Account Actions

Get a Collection of Accounts

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/accounts
Request samples 
Response samples 
application/vnd.api+json
{
}
Create a New Account
SecuritybearerAuth and s2sAuthToken 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/accounts
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Delete an Existing Account by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/accounts/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Get an Account by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/accounts/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Update an Account
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/accounts/{id}
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}